Vcenter VM RelocatePlacementSpec
The Vcenter VM RelocatePlacementSpec schema contains information used to change the placement of an existing virtual machine within the vCenter inventory.
This schema was added in vSphere API 7.0.0.0.
{
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string",
"datastore": "string"
}Virtual machine folder into which the virtual machine should be placed.
This property was added in vSphere API 7.0.0.0.
If this property is missing or null, the virtual machine will stay in the current folder.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
Resource pool into which the virtual machine should be placed.
This property was added in vSphere API 7.0.0.0.
If this property is missing or null, the virtual machine will stay in the current resource pool.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
Host onto which the virtual machine should be placed.
If host and resource_pool are both specified, resource_pool must belong to host.
If host and cluster are both specified, host must be a member of cluster.
This property was added in vSphere API 7.0.0.0.
If this property is unset, if resource_pool is unset, the virtual machine will remain on the current host. if resource_pool is set, and the target is a standalone host, the host is used. if resource_pool is set, and the target is a DRS cluster, a host will be picked by DRS. if resource_pool is set, and the target is a cluster without DRS, InvalidArgument will be thrown.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.
Cluster into which the virtual machine should be placed.
If cluster and resource_pool are both specified, resource_pool must belong to cluster.
If cluster and host are both specified, host must be a member of cluster.
This property was added in vSphere API 7.0.0.0.
If resource_pool or host is specified, it is recommended that this property be missing or null.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.
Datastore on which the virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are associated with the virtual machine, unless individually overridden.
This property was added in vSphere API 7.0.0.0.
If this property is missing or null, the virtual machine will remain on the current datastore.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datastore. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datastore.